MutableSubscriptionSet

A mutable subscription set makes it possible to add, remove or modify a SubscriptionSet. It becomes available when calling SubscriptionSet.update.

Functions

add

abstract fun <T : RealmObject> add(query: RealmQuery<T>, name: String? = null, updateExisting: Boolean = false): Subscription

Adds a new subscription to the subscription set.

findByName

Find the subscription with a given name.

findByQuery

Find the first subscription that contains the given query.

iterator

remove

abstract fun remove(subscription: Subscription): Boolean

Remove a subscription.

abstract fun remove(name: String): Boolean

Remove a named subscription.

removeAll

abstract fun removeAll(): Boolean

Remove all subscriptions in this subscription set.

abstract fun removeAll(objectType: String): Boolean

Remove all subscriptions with queries on a given Subscription.objectType.

Remove all subscriptions with queries on a given model class.

Creates an anonymous Subscription in the current MutableSubscriptionSet directly from a RealmQuery.

Creates a named Subscription in the current MutableSubscriptionSet directly from a RealmQuery.

errorMessage

If state returns SubscriptionSetState.ERROR, this method will return the reason.

size

abstract val size: Int

The number of subscriptions currently in this subscription set.

state

The current state of the SubscriptionSet.